Email Setup

Details

The code you send to your ESP calls the Omnichannel Personalization server once for click-through URL and once for the content asset.

Parameters

Both calls to the Omnichannel Personalization server use these parameters:

Parameter	Required/ Optional	Description	Example
apiKey	required	Unique key that identifies the site. Each Algonomy partner has a unique API key that separates that partners data and traffic from other partners.	apiKey=4faeaf752ee40a0f
apiClientKey	required	Unique key specific to each API implementation—identifies the specific application, or client for reporting, permission, and merchandising. Provided by {rr}.	apiClientKey=b0126f995ac848159d
userId	required	Unique string to identify each user. All user behavior is stored using this key. It is case-sensitive and should be the same UserId sent to {rr} in other applications.	userId=0982347
campaign	optional		campaign=DISPLAY_VALIDATION
date	required	The date that the ESP will send the email.	date=2015-03-16
placement	required	The name of the placement.	placement=abandoncontent
layout	required	The name of the layout.	layout=email_top_content
region	optional	If your site uses regions, set this parameter to the name of the user's region.	region=en-GB
productId	optional	The product ID, if you'd like to record a product associated with the email. The product ID won't affect the content shown to the customer, but will be recorded for future reporting.:	productId=695832145
categoryId	optional	The category ID if the email is associated with a specific category. The category ID won't affect the content shown to the customer, but will be recorded for future reporting.	categoryId=7456
orderId	optional	The order ID, if the email is associated with a specific order. The order ID won't affect the content shown to the customer, but will be recorded for future reporting.	orderId=00004
imageType	optional	If you would like to render Animated GIFs as part of Engage emails, specify imageType=gif in the request from runtime	imageType=gif

Sample ESP Code

Copy

<html>
<head>
<title>Demo of Mailservice (content)</title>
<style>
      @media (min-width: 200px) and (max-width: 420px) {
        div.fordesktop { display: none; }
        div.forpad { display: inline; }
      }
    </style>
</head>
<body bgcolor="#E6E6FA">
<p>
Beta: Demo of Mailservice (content)
<p>
<p>

<!-- BEGIN code for Mailservice rendering content, last edited 18/03/2015 -->
<a href="http://image.richrelevance.com/rrmail/click/content?apiKey=showcaseparent&userId=0&campaign=DISPLAY_VALIDATION&date=2015-03-16&placement=abandoncontent&layout=email_top_content&region=&productId=&categoryId=&orderId=00004">
<img src="http://image.richrelevance.com/rrmail/image/content?apiKey=showcaseparent&userId=0&campaign=DISPLAY_VALIDATION&date=2015-03-16&placement=abandoncontent&layout=email_top_content&region=&productId=&categoryId=&orderId=00004" alt="Content"/>
</a>

<!-- END code for Mailservice -->
<br>
<p>
Above example is an image request to http://image.richrelevance.com (view source)
</body>
</html>